/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package at.irian.demo.jsfatwork.view.page;

import at.irian.demo.jsfatwork.view.MessageBean;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.myfaces.orchestra.conversation.Conversation;
import org.apache.myfaces.orchestra.conversation.ConversationAware;
import org.apache.myfaces.orchestra.viewController.annotations.PreRenderView;

import javax.annotation.PostConstruct;
import javax.faces.application.FacesMessage;
import javax.inject.Inject;

/**
 * @author Gerhard Petracek
 */
public abstract class AbstractPage implements ConversationAware
{
    private final Log logger = LogFactory.getLog(getClass());

    private Conversation conversation;

    @Inject
    @SuppressWarnings({"UnusedDeclaration"})
    private MessageBean messageBean;

    @PostConstruct
    public void init()
    {
        if (this.logger.isDebugEnabled())
        {
            this.logger.debug("bean initialized");
        }
    }

    @PreRenderView
    public void prepareView()
    {
        preparePageForRendering();
    }

    protected void preparePageForRendering()
    {
        //override if needed
    }

    protected void addMessage(String message)
    {
        this.messageBean.addMessage(message);
    }

    protected void addMessage(FacesMessage.Severity severity, String message)
    {
        this.messageBean.addMessage(severity, message);
    }

    protected String getMessageText(String key)
    {
        return this.messageBean.getMessageText(key);
    }

    protected final void cleanup()
    {
        if(this.conversation != null)
        {
            this.conversation.invalidate();
        }
    }

    protected void restartConversation()
    {
        this.conversation.invalidateAndRestart();
    }

    public void setConversation(Conversation conversation)
    {
        this.conversation = conversation;
    }

    //for get requests - see the template
    public Conversation getConversation()
    {
        return this.conversation;
    }
}